namespace ext.data
{
	using System;
	using System.Runtime.CompilerServices;
	using System.Html;
	using System.Collections;
	
	
	/// <summary>
	/// This class encapsulates the field definition information specified in the field definition objects
	/// passed to {@link Ext.data.Record#create}.  Developers do not need to instantiate this class. Instances are created by {@link Ext.data.Record.create}
	/// and cached in the {@link Ext.data.Record#fields fields} property of the created Record constructor&apos;s prototype.
	/// </summary>
	/// <htmlSummary>
	/// &lt;p&gt;This class encapsulates the field definition information specified in the field definition objects
	/// passed to {@link Ext.data.Record#create}.&lt;/p&gt;
	/// &lt;p&gt;Developers do not need to instantiate this class. Instances are created by {@link Ext.data.Record.create}
	/// and cached in the {@link Ext.data.Record#fields fields} property of the created Record constructor&apos;s &lt;b&gt;prototype.&lt;/b&gt;&lt;/p&gt;
	/// </htmlSummary>
	/// <definedin>src\data\DataField.js</definedin>
	[ScriptName("Field")]
	[ScriptNamespace("Ext.data")]
	[Imported()]
	public partial class Field
	{
		
		#region Constructors
		public Field(ext.data.Field_Configuration config)
		{
		}
		
		/// <summary>Constructor</summary>
		public Field()
		{
		}
		#endregion
		
		#region Fields
		/// <summary>
		/// The name by which the field is referenced within the Record. This is referenced by, for example,
		/// the dataIndex property in column definition objects passed to {@link Ext.grid.ColumnModel}.
		/// Note: In the simplest case, if no properties other than name are required, a field
		/// definition may consist of just a String for the field name.
		/// </summary>
		/// <htmlSummary>
		/// The name by which the field is referenced within the Record. This is referenced by, for example,
		/// the &lt;code&gt;dataIndex&lt;/code&gt; property in column definition objects passed to {@link Ext.grid.ColumnModel}.
		/// &lt;p&gt;Note: In the simplest case, if no properties other than &lt;code&gt;name&lt;/code&gt; are required, a field
		/// definition may consist of just a String for the field name.&lt;/p&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		[ScriptName("name")]
		public string Name;
		
		/// <summary>
		/// (Optional) The data type for automatic conversion from received data to the stored value if {@link Ext.data.Field#convert convert}
		/// has not been specified. This may be specified as a string value. Possible values are
		///   auto (Default, implies no conversion)  string  int  float  boolean  date    This may also be specified by referencing a member of the {@link Ext.data.Types} class.  Developers may create their own application-specific data types by defining new members of the
		/// {@link Ext.data.Types} class.
		/// </summary>
		/// <htmlSummary>
		/// (Optional) The data type for automatic conversion from received data to the &lt;i&gt;stored&lt;/i&gt; value if &lt;code&gt;{@link Ext.data.Field#convert convert}&lt;/code&gt;
		/// has not been specified. This may be specified as a string value. Possible values are
		/// &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
		/// &lt;li&gt;auto (Default, implies no conversion)&lt;/li&gt;
		/// &lt;li&gt;string&lt;/li&gt;
		/// &lt;li&gt;int&lt;/li&gt;
		/// &lt;li&gt;float&lt;/li&gt;
		/// &lt;li&gt;boolean&lt;/li&gt;
		/// &lt;li&gt;date&lt;/li&gt;&lt;/ul&gt;&lt;/div&gt;
		/// &lt;p&gt;This may also be specified by referencing a member of the {@link Ext.data.Types} class.&lt;/p&gt;
		/// &lt;p&gt;Developers may create their own application-specific data types by defining new members of the
		/// {@link Ext.data.Types} class.&lt;/p&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("type")]
		public object Type;
		
		/// <summary>
		/// (Optional) A function which converts the value provided by the Reader into an object that will be stored
		/// in the Record. It is passed the following parameters:   v : Mixed The data value as read by the Reader, if undefined will use
		/// the configured {@link Ext.data.Field#defaultValue defaultValue}.   rec : Mixed The data object containing the row as read by the Reader.
		/// Depending on the Reader type, this could be an Array ({@link Ext.data.ArrayReader ArrayReader}), an object
		/// ({@link Ext.data.JsonReader JsonReader}), or an XML element ({@link Ext.data.XMLReader XMLReader}).     
		/// // example of convert function
		/// function fullName(v, record){
		/// return record.name.last + &apos;, &apos; + record.name.first;
		/// }
		///
		/// function location(v, record){
		/// return !record.city ? &apos;&apos; : (record.city + &apos;, &apos; + record.state);
		/// }
		///
		/// var Dude = Ext.data.Record.create([
		/// {name: &apos;fullname&apos;, convert: fullName},
		/// {name: &apos;firstname&apos;, mapping: &apos;name.first&apos;},
		/// {name: &apos;lastname&apos;, mapping: &apos;name.last&apos;},
		/// {name: &apos;city&apos;,...
		/// </summary>
		/// <htmlSummary>
		/// (Optional) A function which converts the value provided by the Reader into an object that will be stored
		/// in the Record. It is passed the following parameters:&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
		/// &lt;li&gt;&lt;b&gt;v&lt;/b&gt; : Mixed&lt;div class=&quot;sub-desc&quot;&gt;The data value as read by the Reader, if undefined will use
		/// the configured &lt;code&gt;{@link Ext.data.Field#defaultValue defaultValue}&lt;/code&gt;.&lt;/div&gt;&lt;/li&gt;
		/// &lt;li&gt;&lt;b&gt;rec&lt;/b&gt; : Mixed&lt;div class=&quot;sub-desc&quot;&gt;The data object containing the row as read by the Reader.
		/// Depending on the Reader type, this could be an Array ({@link Ext.data.ArrayReader ArrayReader}), an object
		/// ({@link Ext.data.JsonReader JsonReader}), or an XML element ({@link Ext.data.XMLReader XMLReader}).&lt;/div&gt;&lt;/li&gt;
		/// &lt;/ul&gt;&lt;/div&gt;
		/// &lt;pre&gt;&lt;code&gt;
		/// // example of convert function
		/// function fullName(v, record){
		/// return record.name.last + &apos;, &apos; + record.name.first;
		/// }
		///
		/// function location(v, record){
		/// return !record.city ? &apos;&apos; : (record.city + &apos;, &apos; + record.state);
		/// }
		///
		/// var Dude = Ext.data.Record.create([
		/// {name: &apos;fullname&apos;, convert: fullName},
		/// {name: &apos;firstname&apos;, mapping: &apos;name.first&apos;},
		/// {name: &apos;lastname&apos;, mapping: &apos;name.last&apos;},
		/// {name: &apos;city&apos;, defaultValue: &apos;homeless&apos;},
		/// &apos;state&apos;,
		/// {name: &apos;location&apos;, convert: location}
		/// ]);
		///
		/// // create the data store
		/// var store = new Ext.data.Store({
		/// reader: new Ext.data.JsonReader(
		/// {
		/// idProperty: &apos;key&apos;,
		/// root: &apos;daRoot&apos;,
		/// totalProperty: &apos;total&apos;
		/// },
		/// Dude // recordType
		/// )
		/// });
		///
		/// var myData = [
		/// { key: 1,
		/// name: { first: &apos;Fat&apos;, last: &apos;Albert&apos; }
		/// // notice no city, state provided in data object
		/// },
		/// { key: 2,
		/// name: { first: &apos;Barney&apos;, last: &apos;Rubble&apos; },
		/// city: &apos;Bedrock&apos;, state: &apos;Stoneridge&apos;
		/// },
		/// { key: 3,
		/// name: { first: &apos;Cliff&apos;, last: &apos;Claven&apos; },
		/// city: &apos;Boston&apos;, state: &apos;MA&apos;
		/// }
		/// ];
		/// &lt;/code&gt;&lt;/pre&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("convert")]
		public System.Delegate Convert;
		
		/// <summary>
		/// (Optional) Used when converting received data into a Date when the {@link #type} is specified as &quot;date&quot;.  A format string for the {@link Date#parseDate Date.parseDate} function, or &quot;timestamp&quot; if the
		/// value provided by the Reader is a UNIX timestamp, or &quot;time&quot; if the value provided by the Reader is a
		/// javascript millisecond timestamp. See {@link Date}
		/// </summary>
		/// <htmlSummary>
		/// &lt;p&gt;(Optional) Used when converting received data into a Date when the {@link #type} is specified as &lt;code&gt;&quot;date&quot;&lt;/code&gt;.&lt;/p&gt;
		/// &lt;p&gt;A format string for the {@link Date#parseDate Date.parseDate} function, or &quot;timestamp&quot; if the
		/// value provided by the Reader is a UNIX timestamp, or &quot;time&quot; if the value provided by the Reader is a
		/// javascript millisecond timestamp. See {@link Date}&lt;/p&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("dateFormat")]
		public string DateFormat;
		
		/// <summary>
		/// (Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed,
		/// null will be used if useNull is true, otherwise the value will be 0. Defaults to false
		/// </summary>
		/// <htmlSummary>
		/// &lt;p&gt;(Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed,
		/// null will be used if useNull is true, otherwise the value will be 0. Defaults to &lt;tt&gt;false&lt;/tt&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("useNull")]
		public bool UseNull;
		
		/// <summary>
		/// (Optional) The default value used when a Record is being created by a {@link Ext.data.Reader Reader}
		/// when the item referenced by the {@link Ext.data.Field#mapping mapping} does not exist in the data
		/// object (i.e. undefined). (defaults to &quot;&quot;)
		/// </summary>
		/// <htmlSummary>
		/// (Optional) The default value used &lt;b&gt;when a Record is being created by a {@link Ext.data.Reader Reader}&lt;/b&gt;
		/// when the item referenced by the &lt;code&gt;{@link Ext.data.Field#mapping mapping}&lt;/code&gt; does not exist in the data
		/// object (i.e. undefined). (defaults to &quot;&quot;)
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("defaultValue")]
		public object DefaultValue;
		
		/// <summary>
		/// (Optional) A path expression for use by the {@link Ext.data.DataReader} implementation
		/// that is creating the {@link Ext.data.Record Record} to extract the Field value from the data object.
		/// If the path expression is the same as the field name, the mapping may be omitted.  The form of the mapping expression depends on the Reader being used.    {@link Ext.data.JsonReader} The mapping is a string containing the javascript
		/// expression to reference the data from an element of the data item&apos;s {@link Ext.data.JsonReader#root root} Array. Defaults to the field name.   {@link Ext.data.XmlReader} The mapping is an {@link Ext.DomQuery} path to the data
		/// item relative to the DOM element that represents the {@link Ext.data.XmlReader#record record}. Defaults to the field name.   {@link Ext.data.ArrayReader} The mapping is a number indicating the Array index
		/// of the field&apos;s value. Defaults to the field specification&apos;s Array position.     If a more complex value extraction strategy is required,...
		/// </summary>
		/// <htmlSummary>
		/// &lt;p&gt;(Optional) A path expression for use by the {@link Ext.data.DataReader} implementation
		/// that is creating the {@link Ext.data.Record Record} to extract the Field value from the data object.
		/// If the path expression is the same as the field name, the mapping may be omitted.&lt;/p&gt;
		/// &lt;p&gt;The form of the mapping expression depends on the Reader being used.&lt;/p&gt;
		/// &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
		/// &lt;li&gt;{@link Ext.data.JsonReader}&lt;div class=&quot;sub-desc&quot;&gt;The mapping is a string containing the javascript
		/// expression to reference the data from an element of the data item&apos;s {@link Ext.data.JsonReader#root root} Array. Defaults to the field name.&lt;/div&gt;&lt;/li&gt;
		/// &lt;li&gt;{@link Ext.data.XmlReader}&lt;div class=&quot;sub-desc&quot;&gt;The mapping is an {@link Ext.DomQuery} path to the data
		/// item relative to the DOM element that represents the {@link Ext.data.XmlReader#record record}. Defaults to the field name.&lt;/div&gt;&lt;/li&gt;
		/// &lt;li&gt;{@link Ext.data.ArrayReader}&lt;div class=&quot;sub-desc&quot;&gt;The mapping is a number indicating the Array index
		/// of the field&apos;s value. Defaults to the field specification&apos;s Array position.&lt;/div&gt;&lt;/li&gt;
		/// &lt;/ul&gt;&lt;/div&gt;
		/// &lt;p&gt;If a more complex value extraction strategy is required, then configure the Field with a {@link #convert}
		/// function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to
		/// return the desired data.&lt;/p&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("mapping")]
		public ext.auto.System_String_Or_System_Number Mapping;
		
		/// <summary>
		/// (Optional) A function which converts a Field&apos;s value to a comparable value in order to ensure
		/// correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom
		/// sort example: 
		/// // current sort after sort we want
		/// // +-+------+ +-+------+
		/// // |1|First | |1|First |
		/// // |2|Last | |3|Second|
		/// // |3|Second| |2|Last |
		/// // +-+------+ +-+------+
		///
		/// sortType: function(value) {
		/// switch (value.toLowerCase()) // native toLowerCase():
		/// {
		/// case &apos;first&apos;: return 1;
		/// case &apos;second&apos;: return 2;
		/// default: return 3;
		/// }
		/// }
		/// </summary>
		/// <htmlSummary>
		/// (Optional) A function which converts a Field&apos;s value to a comparable value in order to ensure
		/// correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom
		/// sort example:&lt;pre&gt;&lt;code&gt;
		/// // current sort after sort we want
		/// // +-+------+ +-+------+
		/// // |1|First | |1|First |
		/// // |2|Last | |3|Second|
		/// // |3|Second| |2|Last |
		/// // +-+------+ +-+------+
		///
		/// sortType: function(value) {
		/// switch (value.toLowerCase()) // native toLowerCase():
		/// {
		/// case &apos;first&apos;: return 1;
		/// case &apos;second&apos;: return 2;
		/// default: return 3;
		/// }
		/// }
		/// &lt;/code&gt;&lt;/pre&gt;
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("sortType")]
		public System.Delegate SortType;
		
		/// <summary>
		/// (Optional) Initial direction to sort (&quot;ASC&quot; or &quot;DESC&quot;). Defaults to
		/// &quot;ASC&quot;.
		/// </summary>
		/// <htmlSummary>
		/// (Optional) Initial direction to sort (&lt;code&gt;&quot;ASC&quot;&lt;/code&gt; or &lt;code&gt;&quot;DESC&quot;&lt;/code&gt;). Defaults to
		/// &lt;code&gt;&quot;ASC&quot;&lt;/code&gt;.
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("sortDir")]
		public string SortDir;
		
		/// <summary>
		/// (Optional) Used for validating a {@link Ext.data.Record record}, defaults to true.
		/// An empty value here will cause {@link Ext.data.Record}.{@link Ext.data.Record#isValid isValid}
		/// to evaluate to false.
		/// </summary>
		/// <htmlSummary>
		/// (Optional) Used for validating a {@link Ext.data.Record record}, defaults to &lt;code&gt;true&lt;/code&gt;.
		/// An empty value here will cause {@link Ext.data.Record}.{@link Ext.data.Record#isValid isValid}
		/// to evaluate to &lt;code&gt;false&lt;/code&gt;.
		/// </htmlSummary>
		/// <definedin>src\data\DataField.js</definedin>
		/// <optional>Optional Field</optional>
		[ScriptName("allowBlank")]
		public bool AllowBlank;
		#endregion
	}
}
